Skip to content

Helm charts for PC#10848

Open
katarzyna-koltun-mx wants to merge 3 commits intodevelopmentfrom
kk-pc-helm
Open

Helm charts for PC#10848
katarzyna-koltun-mx wants to merge 3 commits intodevelopmentfrom
kk-pc-helm

Conversation

@katarzyna-koltun-mx
Copy link
Collaborator

No description provided.

Comment on lines +51 to +66
{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png" >}}

6. In the **General Settings** tab, enter the cluster that you created in step 1.
7. Follow the wizard to configure the other options according to your requirements.

You must specify the database, [storage plan](/developerportal/deploy/private-cloud-storage-plans/), [ingress](/deploy/private-cloud-cluster/private-cloud-ingress-settings/), and [registry](/developerportal/deploy/private-cloud-registry/).

8. Click **Generate & Download** to generate the yaml file with the configurations that you provided.

9. Run the following command: `helm install -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`.

The installer performs the basic installation and applies the configurations at the same time.

## Upgrading the Operator with Helm Charts

If you want to update your configuration (for example, change the database), recreate the yaml file by using the same wizard as above, and then run the following command: `helm update -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`. No newline at end of file
Copy link
Contributor

@ilholbea ilholbea Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The screenshot must be updated since now have a Service Account section.

Copy link
Contributor

@Nidhi251289 Nidhi251289 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first set of review comments

6. In the **General Settings** tab, enter the cluster that you created in step 1.
7. Follow the wizard to configure the other options according to your requirements.

You must specify the database, [storage plan](/developerportal/deploy/private-cloud-storage-plans/), [ingress](/deploy/private-cloud-cluster/private-cloud-ingress-settings/), and [registry](/developerportal/deploy/private-cloud-registry/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it would make sense if we can add separate sections such as Database, Storage, Proxy, Ingress etc. Along with that we can add the screenshots for them

The solution currently has the following limitations compared to using the mxpc-cli tool:

* The Helm chart UI cannot be used to configure the Global Operator.
* Upgrading namespaces is not supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with : We dont have any UI driven upgrade approach

url: /developerportal/deploy/helm-charts/
description: "Describes how to configure your installation with Helm charts in Mendix on Kubernetes."
weight: 50
beta: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the beta to false.

By default, Mendix on Kubernetes uses the mxpc-cli tool for configuring namespaces and performing base installations. However, customers can also integrate Helm charts into their pipelines in order to directly install components and run the configurations through the Helm chart UI.

The solution consists of two main components: the Helm charts themselves, and a tool called Mendix CLI. The Mendix CLI acts as a UI for customers, allowing them to input configurations and then generate Helm charts from those inputs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace "and then generate Helm charts from those inputs."
with "and then generate Helm charts values from the helm charts"


## Introduction

By default, Mendix on Kubernetes uses the mxpc-cli tool for configuring namespaces and performing base installations. However, customers can also integrate Helm charts into their pipelines in order to directly install components and run the configurations through the Helm chart UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General note: Can you make this document as a second person instead of mentioning the "customers can", use something like "U can integrate Helm chart ......"

* Upgrading namespaces is not supported.
* Namespaces initially created with mxpc-cli cannot be migrated and managed with Helm charts.

## Installing the Operator with Helm Charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace with:
Installing and Configuring the Mendix on Kubernetes with Helm Charts

9. Run the following command: `helm install -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`.

The installer performs the basic installation and applies the configurations at the same time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a new section:

Uninstall Mendix on Kubernetes

If u want to uninstall, follow the official documentation.


The installer performs the basic installation and applies the configurations at the same time.

## Upgrading the Operator with Helm Charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace :
Applying the configuration changes with Helm Charts

weight: 50
beta: true
---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the note:

Before using Helm charts, kindly ensure to go through the official Helm documentation.

8. Click **Generate & Download** to generate the yaml file with the configurations that you provided.

9. Run the following command: `helm install -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add :
Once you run above command, ensure that your cluster have access to Mendix on Kubernetes portal for adding the Storage Plans. The Private cloud portal should be safelisted in the cluster.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants